home *** CD-ROM | disk | FTP | other *** search
/ InterCD 2000 September / september_2000.iso / intercd / root / ^Linux / WindowMaker / README < prev    next >
Encoding:
Text File  |  2000-03-29  |  13.8 KB  |  391 lines
  1.  
  2.  
  3.  
  4.                        GNU Window Maker
  5.                           X11 Window Manager
  6.  
  7.                     <http://windowmaker.org>
  8.               <ftp://ftp.windowmaker.org>
  9.  
  10.                      by
  11.  
  12.                        Alfredo K. Kojima 
  13.  
  14.                   Dan Pascu
  15.  
  16.                          Matthew Hawkins
  17.  
  18.                     ]d
  19.  
  20.  
  21.                    Web/FTP Master
  22.  
  23.                    Phillip Smith
  24.  
  25.  
  26.  
  27.         Congratulations! You have purchased an extremely fine
  28.     device that would give you thousands of years of trouble-free 
  29.     service, except    that you undoubtably will destroy it via some 
  30.     typical bonehead consumer maneuver. Which is why we ask you
  31.     to PLEASE FOR GOD'S SAKE READ THIS OWNER'S MANUAL CAREFULLY
  32.     BEFORE YOU UNPACK THE DEVICE. YOU ALREADY UNPACKED IT, DIDN'T
  33.     YOU? YOU UNPACKED IT AND PLUGGED IT IN AND TURNED IT ON AND 
  34.     FIDDLED WITH THE KNOBS, AND NOW YOUR CHILD, THE    SAME CHILD WHO
  35.     ONCE SHOVED A POLISH SAUSAGE INTO YOUR VIDEOCASSETTE RECORDER
  36.     AND SET IT ON "FAST FORWARD", THIS CHILD ALSO IS FIDDLING
  37.     WITH THE KNOBS, RIGHT?  AND YOU'RE JUST NOW STARTING TO READ 
  38.     THE INSTRUCTIONS, RIGHT???  WE MIGHT AS WELL JUST BREAK THESE 
  39.     DEVICES    RIGHT AT THE FACTORY BEFORE WE SHIP THEM OUT, YOU 
  40.     KNOW THAT? 
  41.                 -- Dave    Barry, "Read This First!"
  42.  
  43.  
  44. Description
  45. ===========
  46.  
  47. Window Maker is the GNU window manager for the X Window System. It was
  48. designed to emulate the look and feel of part of the NEXTSTEP(tm) GUI. It's
  49. supposed to be relatively fast and small, feature rich, easy to configure and
  50. easy to use, with a simple and elegant appearance borrowed from NEXTSTEP(tm).
  51.  
  52. Window Maker was designed keeping integration with GNUstep in mind and is the
  53. "official" window manager for it. It is also part of the GNU project
  54. (www.gnu.org) Read more about GNUstep further on this file.
  55.  
  56. Hints (information given by applications to integrate well with the window 
  57. manager) for Motif(tm), OPEN LOOK(tm), KDE and GNOME are also supported. 
  58. So you can replace any of the window managers for these environments
  59. with Window Maker while keeping most, if not all, of the native window manager
  60. functionality.
  61.  
  62. Window Maker was previously called WindowMaker.
  63.  
  64. Window Maker has no connection with Windowmaker, the software for
  65. making windows and doors.
  66.  
  67.  
  68. Documentation
  69. =============
  70.  
  71. Read before asking.
  72.  
  73. * README files all over the source tree have info related to the stuff
  74. in the directories. 
  75.  
  76. * INSTALL has installation instructions and some troubleshooting tips.
  77. You're meant to read it before installing. it was not written just to 
  78. fill up space in the package...
  79.  
  80. * FAQ: Frequently Asked Questions. READ IT!!! FAQ.I18N is for
  81. internationalization related questions.
  82.  
  83. * NEWS: list user visible changes from the previous version. Read it if
  84. you are upgrading.
  85.  
  86. * MIRRORS: some alternative places where you can get Window Maker,
  87. including platform specific packages of Window Maker.
  88.  
  89. * BUGFORM: use it to send bug reports. Please do use it.
  90.  
  91. * ChangeLog: what changed from the previous version?
  92.  
  93. * BUGS: list of known bugs
  94.  
  95.  
  96. *** User Guide
  97.  
  98. The Window Maker User's Guide can be downloaded from the official ftp
  99. or web sites.
  100. It can also be viewed in HTML format in:
  101. http://people.delphi.com/crc3419/WMUserGuide/index.htm
  102.  
  103. The User Guide explains how to use Window Maker, the configuration files
  104. and options.
  105.  
  106.  
  107. *** man pages
  108.  
  109. Type "man wmaker" in the shell prompt to get general help about Window Maker
  110.  
  111.  
  112.  
  113. Directories & Files in the Source Tree
  114. ======================================
  115.  
  116. * Install is a script for configuring and compiling Window Maker in a easy
  117. way (not that the normal way is difficult, but...).
  118.  
  119. * AUTHORS: the credits
  120.  
  121. * TODO: plans for the future
  122.  
  123. * contrib/ has some contributed patches that are not supported by Window Maker
  124.   because they conflict with design filosophies of the developers or some 
  125.   other reason.
  126.  
  127. * util/ has various utility programs.
  128.  
  129. * WPrefs.app/ is the configuration program. 
  130.  
  131. * src/wconfig.h has compile time options you can change to select some
  132. options/features and other stuff. 
  133.  
  134. * WINGs/ NEXTSTEP lookalike widget library
  135.  
  136. * wrlib/ image processing library
  137.  
  138. * po/ has message catalogs wich are the translated versions of the messages
  139. displayed by Window Maker.
  140.  
  141. * docklib-x.x.tar.gz  a library for writing dockapps
  142.  
  143.  
  144. HELP ME!!!
  145. ==========
  146.  
  147. There is a mailing list for discussing Window Maker at
  148. wm-user@windowmaker.org To subscribe to it, send a message containing:
  149.     subscribe 
  150. in the subject of the message to wm-user-request@windowmaker.org
  151.  
  152. If you got a problem, ask there (after reading the docs, of course). The
  153. people there is more likely to be able to answer your questions than we are.
  154. For bug reports use the BUGFORM.
  155.  
  156. If you have a problem with a precompiled version of Window Maker 
  157. (rpm, deb etc), first ask the person who made the package.
  158.  
  159. IMPORTANT NOTE: when asking for help (in the mailing list or to the
  160. developerts, directly) *always* send information about the system you are
  161. using. You can use the system information section at the end of BUGFORM as a
  162. guideline. Another thing: please don't send HTML mail.
  163.  
  164.  
  165. There is also a #windowmaker IRC channel at openprojects. To join there,
  166. connect your irc client to irc.openprojects.net, irc.linux.com or some other
  167. server of that network.
  168.  
  169.  
  170. GNUstep
  171. =======
  172.  
  173. GNUstep is a complete object-oriented development system, based on the
  174. OpenStep specification released by NeXT(tm) (now Apple(tm)) and Sun(tm). It
  175. will provide everything one needs to produce cross-platform, object-oriented,
  176. graphical (and non-graphical) applications; providing among other things,
  177. base system libraries, a high-level GUI application framework that uses a
  178. Display PostScript(tm)-like imaging model (DGS), objects for accessing
  179. relational databases, distributed objects and a graphical development
  180. environment, with tools like interface modeller, a project management system
  181. (project center) and other tools.
  182.  
  183. The GNUstep development system will be used to create a user environment,
  184. with everything needed for a complete graphical user interface, such as a
  185. file viewer, text editors and other applications. Note that the user
  186. environment (or "desktop environment") is only a small part of the whole
  187. GNUstep project and therefore it does not "compete" with other projects like
  188. KDE or GNOME, simply because they are completely different things.
  189.  
  190. For more information on the GNUstep project, visit: http://www.gnustep.org
  191. and http://gnustep.current.nu
  192.  
  193.  
  194. Running multiple instances of Window Maker
  195. ==========================================
  196.  
  197. It is not a good idea to run more than one instance of Window Maker
  198. from the same user (so that wmaker will use the same configuration
  199. files) at the same time. You might get unexpected behaviour when Window Maker
  200. updates it's configuration files.
  201.  
  202. If you really desire to do this, try running Window Maker with the 
  203. command line option --static so that it will not update or change
  204. any of the configuration files.
  205.  
  206. Sound support
  207. =============
  208.  
  209. Sound is supported for Linux and FreeBSD systems with the use of a
  210. separately distributed module called WSoundServer. There is also a graphical
  211. configuration tool for setting up your sounds called WSoundPrefs.
  212. You can download these at:
  213. http://shadowmere.student.utwente.nl/
  214.  
  215. Note that you must compile Window Maker with the --enable-sound configure
  216. flag and set the DisableSound option to NO.
  217.  
  218.  
  219. OpenL**k support
  220. ================
  221.  
  222. I guess many users, mainly from the academic world, have to use
  223. applications written using the OpenL**k toolkits, so having support
  224. for these apps must be of some use.
  225.  
  226. To enable, use --enable-openlook when doing the configure. Note that
  227. not everything is implemented. 
  228.  
  229. Implemented stuff include decoration hints and the push-pin. Not implemented
  230. stuff include _SUN_WINDOW_STATE (the compose led state stuff), drag and drop
  231. interest stuff, header (not sure what's it) and footer strings.
  232.  
  233. Please give me feedback if something doesn't work. If the feature is
  234. already implemented, but is not working because of a bug, I'll try to
  235. have that fixed. If it's a non-implemented feature and you mention that
  236. it's important (ie: not just cosmetical), I'll consider implementing it.
  237.  
  238. The "out" state of the pushpin is emulated as a pushed-in close button.
  239. Just click on the button to make it pushed-out, which corresponds
  240. to the pinned-in state of the pushpin. If you push again in the pushed-out
  241. close button, it will act as a normal close button: it will close the window.
  242.  
  243.  
  244. Performance Tuning
  245. ==================
  246.  
  247. If you want to diminish Window Maker's memory usage and improve performance,
  248. while keeping a nice appearance and good functionality, follow the items
  249. bellow:
  250.  
  251. - use solid textures for everything, mainly titlebars and menus. If you
  252.   want a nice looking desktop, use the Traditional style.
  253. - turn NewStyle and Superfluous off
  254. - do not bind many shortcuts in the menu and keep only the essential items
  255.   in the menu
  256. - turn on DisableClip
  257. - edit wconfig.h and disable the NUMLOCK_HACK and the features you
  258.   don't use anyway (keep in mind that some of the #defines might not
  259.   work, as they are not fully supported). Make sure to always keep
  260.   NumLock and ScrollLock turned off.
  261. - turn on DisableAnimations. You can also #undefine ANIMATIONS in wconfig.h
  262. - strip down the default IconPath and PixmapPath entries to contain only 
  263.   the paths that you really have in your system. 
  264. - do not use large images in the root background
  265. - remove support for image formats you don't use
  266. - to reduce memory usage, disable the icon cache, by setting the RIMAGE_CACHE
  267.   environment variable to 0. If you want to increase performance at the cost
  268.   of memory usage, set it's value to a value like the number of different
  269.   icons you use.
  270.  
  271.  
  272. Keyboard Mouse Control
  273. ======================
  274.  
  275. Many people ask about adding keyboard control of mouse, like in fvwm,
  276. but Window Maker will not have such feature. The XKB extension supports
  277. mouse simulation from the keyboard, in a much more powerfull fashion than
  278. any simulation done by a window manager. 
  279.  
  280. To enable it, hit the Control+Shift+NumLock or Shift+NumLock key combination. 
  281. You should hear the speaker beeping. To disable it, do the same thing.
  282.  
  283. To control the mouse the numeric keypad is used as follows:
  284. - 4 (left arrow), 7 (Home), 8 (up arrow), 9 (PgUp), 6 (right arrow), 
  285. 3 (PgDn), 2 (down arrow) and 1 (End) move the mouse to the corresponding
  286. direction;
  287. - holding one of the above keys and then holding the 5 key will move the
  288. pointer faster;
  289. - / will select the first mouse button (left button);
  290. - * will select the second mouse button (middle button);
  291. - - will select the third mouse button (right button);
  292. - 5 will do a click with the currently selected mouse button;
  293. - + will do a double-click with the currently selected button;
  294. - 0 (Ins) will click and hold the currently selected button;
  295. - . (Del) will release the currently selected button that was previously
  296. clicked with the 0 (Ins) key.
  297.  
  298.  
  299. The above key values work in a XFree86 3.2 (X11R6.1) X server but your
  300. milleage may vary.
  301.  
  302.  
  303. How to make a gdb backtrace
  304. ===========================
  305.  
  306. Backtraces can help us fix bugs that make Window Maker crash. If you
  307. find a bug that crashes Window Maker, please send a backtrace with your
  308. bug report.
  309.  
  310. To make a usefull backtrace, you need a core file with debugging
  311. information produced by Window Maker when it crashes. It should 
  312. have been installed without stripping too. If you
  313. get the dialog window telling you that wmaker crashed and asks you
  314. what to do, tell it to "Abort and leave a core file".
  315.  
  316. script
  317. cd src
  318. gdb .libs/wmaker path_to_the_core_file
  319.  
  320. Then, in the gdb prompt type "bt". Quit from gdb by typing "quit"
  321. and then, in the shell prompt, type "exit".
  322.  
  323. The file named typescript will contain the backtrace.
  324.  
  325.  
  326.  
  327. Copyrights & Disclaimers
  328. ========================
  329.  
  330. Window Maker is copyrighted by Alfredo K. Kojima and is licensed through the
  331. GNU General Public License. Read the COPYING file for the complete license.
  332.  
  333. The icons that are distributed with this program and were made by Marco van
  334. Hylckama Vlieg, are licensed through the GNU General Public License. Read the 
  335. COPYING file for the complete license.
  336.  
  337. The icons listed in COPYING.WTFPL and are distributed in this 
  338. program and were made by Banlu Kemiyatorn (]d), are licensed through the
  339. "do What The Fuck you want to Public License". Read the COPYING.WTFPL
  340. file for the complete license.
  341.  
  342. NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc.
  343. All other trademarks are property of their respective owners.
  344.  
  345. The authors reserve the right to make changes in the software without prior
  346. notice.
  347.  
  348.  
  349. Authors
  350. =======
  351.  
  352. Alfredo K. Kojima <kojima@windowmaker.org>
  353. Dan Pascu <dan@windowmaker.org>
  354. Matt Hawkins <matt@windowmaker.org>
  355. ]d <id@windowmaker.org>
  356.  
  357. Please don't ask us questions before reading the documentation (esp. the
  358. FAQ, this file and INSTALL files) and about "cool" things you see in
  359. people's desktop screenshots.
  360.  
  361.  
  362. The AUTHORS file contains a list of the people who have contributed to the
  363. project. The name of people who have helped with localization (translation)
  364. can be found in po/README and Window Maker/README
  365.  
  366. If you have any comments, fixes and bug reports (filled BUGFORMs) send them
  367. to developers@windowmaker.org
  368.  
  369.  
  370.  
  371.  
  372. Musicware
  373. =========
  374.  
  375. If you use Window Maker and *really* like it, please consider making my day
  376. by sending me a music CD (or a MiniDisc or even a MP3 CDR) of your favorite
  377. band, singer, instrumentist, composer or whatever :^). I like listening to
  378. music and would love to get new CDs, especially from other parts of the
  379. world. I like almost any kind of music, from Ozzy Osbourne to Bach (mas nπo
  380. pagode e sertanejo pelamordideus :), so I will be happy to receive just about
  381. anything.
  382.  
  383. Snail mail address:
  384.  
  385. Alfredo Kengi Kojima
  386. Rua Firmino O. Bimbi, 255/25B
  387. Porto Alegre - RS
  388. CEP 91751-330
  389. Brazil
  390.  
  391.